home *** CD-ROM | disk | FTP | other *** search
/ Windows Expert / Windows Expert.iso / database / winsql20.zip / README.DOC < prev    next >
Text File  |  1991-10-26  |  20KB  |  439 lines
  1.  
  2.           General Information                                Page 1 of 8
  3.  
  4.  
  5.                               Orion SQL For Windows
  6.  
  7.                            Release 2.0 - November 1991
  8.  
  9.  
  10.                                GENERAL INFORMATION
  11.  
  12.  
  13.                      Copyright (c) 1991 by Stellar Industries
  14.                                All Rights Reserved
  15.  
  16.  
  17.                              Release 2.0 Enhancements
  18.  
  19.  
  20.           Orion SQL For Windows Release 2.0 adds significant new
  21.           features:
  22.  
  23.           ***** Orion SQL Applications Programming Interface (API)
  24.  
  25.           What is the Orion SQL API?
  26.  
  27.                The Orion SQL API is a powerful tool that enables you,
  28.                the software developer, to have full access to a modern,
  29.                highly optimized ANSI standard SQL database manager: the
  30.                Orion Database Administrator.  Your programs written in
  31.                any language which can access dynamic link libraries can
  32.                also access the Orion SQL API.  These languages include
  33.                'C', 'C++', 'Visual Basic', 'Pascal' and most assemblers.
  34.                In fact, any program which can access the Microsoft
  35.                Windows environment can access the Orion SQL API.
  36.                Microsoft Windows itself is a dynamic link library.
  37.  
  38.                The Orion SQL API is your gateway to modern database
  39.                technology.  With a little more than a dozen functions
  40.                and only 4 data structures you can perform almost any
  41.                database task.
  42.  
  43.           How does the Orion SQL API work?
  44.  
  45.                "How is this done?"  you might ask.  Well, while the
  46.                Orion Database Administrator is sophisticated, complex
  47.                and fully optimized for maximum performance: the Orion
  48.                SQL API is simple and straight forward.  The Orion SQL
  49.                API effectively buffers you from all the complex tasks of
  50.                parsing, query analysis, query optimization, query tree
  51.                construction, etc.
  52.  
  53.           How do I link to the Orion SQL API?
  54.  
  55.                When programming in 'C', you need to do only three things
  56.                to include all the power of SQL in your application:
  57.           General Information                                Page 2 of 8
  58.  
  59.  
  60.                1)   When you link your object modules, include the
  61.                     SQL.LIB import library along with libw.lib.
  62.  
  63.                2)   Include the SQL.H file (e.g. "#include <sql.h>") in
  64.                     your source code.
  65.  
  66.                3)   Put the Orion Database Administrator (DBA.EXE) and
  67.                     Orion SQL API (SQL.DLL) someplace where windows can
  68.                     find them (usually in your windows directory).
  69.  
  70.                When programming in 'Visual Basic', you need to do only
  71.                two things to include all the power of SQL in your
  72.                application:
  73.  
  74.                1)   Be sure to use the SQL.GBL file included with the
  75.                     Orion SQL API.  Note that the 'C' style prefixes
  76.                     used with variable names (i.e. the 'n' in
  77.                     nResultCode, and the 'sz' in szErrorMessage) are not
  78.                     used with 'Visual Basic'.
  79.  
  80.                2)   Put the Orion Database Administrator (DBA.EXE) and
  81.                     Orion SQL API (SQL.DLL) someplace where windows can
  82.                     find them (usually in your windows directory).
  83.  
  84.           How do I use the Orion SQL API?
  85.  
  86.                Your program can login to the Orion Database
  87.                Administrator (SqlLogin), open a cursor (SqlCursorOpen)
  88.                and execute a query (SqlExecute).  The query itself is
  89.                passed to the Orion SQL API as a simple text string.  The
  90.                Orion SQL API does all the work for you.  To get your
  91.                answers back (from a SELECT statement, for example) you
  92.                simply fetch them one at a time from the Orion SQL API.
  93.                You can fetch the first record (SqlFetchFirst), last
  94.                record (SqlFetchLast), next record (SqlFetchNext),
  95.                previous record (SqlFetchPrevious) or even a record at a
  96.                position you specify (SqlFetchPositioned).
  97.  
  98.                You can have several cursors open at a time so that you
  99.                can access your data the way you want.
  100.  
  101.                When you're all done, close your cursors (SqlCursorClose)
  102.                and log out (SqlLogout).
  103.  
  104.           How can I check out my SQL statements?
  105.  
  106.                You can check out your SQL statements using the Orion
  107.                Query Editor (QE.EXE) included with the Orion SQL API.
  108.                The Orion Query Editor allows you to type in the query
  109.                your program is going to send to the Orion SQL API and
  110.                have it execute right there in front of you.  You'll get
  111.                all the results back on the screen where you can verify
  112.                it's what you expected.  In fact, the Orion Query Editor
  113.                uses the Orion SQL API the same way your program does.
  114.           General Information                                Page 3 of 8
  115.  
  116.  
  117.           ***** GENERAL PERFORMANCE IMPROVEMENT
  118.  
  119.                Orion SQL For Windows Release 2.0 has significant
  120.                performance improvements over both Release 1.0 (about 6
  121.                fold) and Release 1.1 (about 2 fold) as evidenced by the
  122.                timings below.  These queries are available to you in the
  123.                EXAMPLE.ZIP file.
  124.  
  125.             +--------------------------------------------------------+
  126.             | release:           |    1.0    |    1.1    |    2.0    |
  127.             |--------------------+-----------+-----------+-----------|
  128.             | QUERY15.SQL        |  6.0 sec. |  1.4 sec. |  0.5 sec. |
  129.             |--------------------+-----------+-----------+-----------|
  130.             | QUERY16.SQL        |  5.1 sec. |  1.9 sec. |  1.0 sec. |
  131.             +--------------------------------------------------------+
  132.               (80386 33MHz, 17 msec IDE disk, HYPERDISK disk cache)
  133.  
  134.           ***** OTHER ENHANCEMENTS
  135.  
  136.                Significantly fewer records are written to the
  137.                transaction journal.
  138.  
  139.  
  140.  
  141.                      Unpacking and Installation Instructions
  142.  
  143.  
  144.           Orion SQL For Windows is provided as a single compressed file.
  145.           (WINSQL20.ZIP).  The contents of WINSQL20.ZIP are defined in
  146.           the included PACKING.LST file.
  147.  
  148.           Efficient operation of SQL For Windows requires that you use a
  149.           disk cache manager (such as MicroSoft's SMARTDRV.SYS).  For
  150.           superior performance use a disk cache manager which also
  151.           caches disk writes, such as Norton Disk Cache (available with
  152.           Norton Utilities) or Hyperdisk Disk Accelerator (available as
  153.           shareware from HyperWare*).  We at Stellar Industries
  154.           recommend Hyperdisk Disk Accelerator with which we observe a
  155.           three to six fold performance enhancement verses SMARTDRV.SYS.
  156.           Hyperdisk is available on many BBS's as HYDK421.ZIP.
  157.           Documentation for these disk cache managers should be
  158.           carefully reviewed.  Utilizing SMARTDRV.SYS instead of
  159.           HyperDisk, the above timings become:
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.           ____________________
  168.  
  169.           *  HyperWare, RR#1 Box 91, Pall Mall, TN 38577; voice: (615)
  170.           864-6868; BBS: 8N1 (HST, V.32, V.22bis): (615) 864-6871
  171.           General Information                                Page 4 of 8
  172.  
  173.  
  174.             +--------------------------------------------------------+
  175.             | release:           |    1.0    |    1.1    |    2.0    |
  176.             |--------------------+-----------+-----------+-----------|
  177.             | QUERY15.SQL        | 20.0 sec. |  4.7 sec. |  1.8 sec. |
  178.             |--------------------+-----------+-----------+-----------|
  179.             | QUERY16.SQL        | 22.0 sec. |  8.4 sec. |  5.9 sec. |
  180.             +--------------------------------------------------------+
  181.  
  182.           Adding indices to tables greatly enhances performance.  A
  183.           simple SELECT which extracts 5 records from a table of 3000
  184.           takes 10.6 seconds without an index.  The same SELECT
  185.           statement takes only 0.6 seconds when there is an index on the
  186.           table.
  187.  
  188.           While indices may be created at any time, we recommend that
  189.           you create indices immediately after you create their base
  190.           tables, otherwise CREATE INDEX has to read and rewrite all
  191.           data which is already in the table.
  192.  
  193.           The importance of a good disk cache manager and thoughtful
  194.           database design including the use of indices (where
  195.           appropriate) cannot be over emphasized.
  196.  
  197.           In order to properly install SQL For Windows on your computer
  198.           you will need to perform the following steps:
  199.  
  200.           1)   Use your favorite editor (NOTEPAD.EXE will suffice) to
  201.                insure that your 'CONFIG.SYS' file has the 'FILES=' MSDOS
  202.                parameter set to at least 30.
  203.  
  204.           2)   Move DBA.EXE, DBA.HLP, QE.EXE, QE.HLP, SQL.DLL and
  205.                SQL.HLP to the directory in which you keep windows
  206.                programs.  This is usually the 'c:\windows' directory.
  207.  
  208.           3)   Make two new directories.  One will be for the Orion
  209.                Database Administrator's files (we recommend naming it
  210.                'database'), the other will be for your queries and data
  211.                (we recommend naming it 'data').  You can use the MS-DOS
  212.                'mkdir' command to do this.
  213.  
  214.           4)   Unpack EXAMPLE.ZIP (contained within WINSQL20.ZIP).  This
  215.                file contains both sample queries and an import file to
  216.                load some sample data into the database.  We recommend
  217.                putting these files in your 'data' directory.
  218.  
  219.           5)   Use your favorite editor (NOTEPAD.EXE will suffice) to
  220.                modify the windows initialization file WIN.INI.  This
  221.                file can usually be found in the 'c:\windows' directory.
  222.                Add the following lines:
  223.  
  224.                     [OrionDba]
  225.                     AutoStart=1
  226.                     DatabasePath=c:\database
  227.                     DataFilePath=c:\data
  228.           General Information                                Page 5 of 8
  229.  
  230.  
  231.                     FileNameDatabaseDump=c:\temp\orion.dmp
  232.  
  233.                     [OrionQe]
  234.                     Acknowledge=1
  235.                     DataFilePath=c:\data
  236.                     OpenNew=1
  237.                     UserName=SYSTEM
  238.                     UserPassword=ORION
  239.                     WarnOnClose=1
  240.  
  241.                As DBA.EXE and QE.EXE automatically add some of these
  242.                lines if they do not already exist, be sure you are not
  243.                adding duplicate entries.  If you edit WIN.INI before
  244.                running DBA.EXE or QE.EXE you don't have to worry.
  245.  
  246.                These entries have the following meanings:
  247.  
  248.                [OrionDba]          Identifies a block of entries as
  249.                                    belonging to the Orion Database
  250.                                    Administrator.
  251.  
  252.                AutoStart           Set to '0' or '1'. When set to '1'
  253.                                    causes the Orion Database
  254.                                    Administrator to automatically start
  255.                                    the database as soon as you start the
  256.                                    program.
  257.  
  258.                DatabasePath        Set to the path you want the database
  259.                                    files to reside in.  Make sure to
  260.                                    create this directory before starting
  261.                                    the Orion Database Administrator.  We
  262.                                    recommend naming it 'database'.
  263.  
  264.                DatafilePath        Set to the path you want to use as
  265.                                    the default for import and export
  266.                                    operations.  We recommend naming it
  267.                                    'data'.
  268.  
  269.                FileNameDatabaseDump       Set to the full file name of
  270.                                    the file you want the Orion Database
  271.                                    Administrator to use for the 'dump'
  272.                                    operation.
  273.  
  274.                [OrionQe]           Identifies a block of entries as
  275.                                    belonging to the Orion Query Editor.
  276.  
  277.                Acknowledge         Set to '0' or '1'. When set to '1'
  278.                                    causes the Orion Query Editor to
  279.                                    display an informational dialog box
  280.                                    every time a query completes.
  281.  
  282.                DataFilePath        Set to the path you want to use as
  283.                                    the default for file operations.  We
  284.                                    recommend naming it 'data'.
  285.           General Information                                Page 6 of 8
  286.  
  287.  
  288.                OpenNew             Set to '0' or '1'. When set to '1'
  289.                                    causes the Orion Query Editor to
  290.                                    automatically create a new 'pad' when
  291.                                    the Query Editor first starts.
  292.  
  293.                UserName            Set to 'SYSTEM'.  This identifies the
  294.                                    default user name.
  295.  
  296.                UserPassword        Set to 'ORION'.  This identifies the
  297.                                    default user password.
  298.  
  299.                WarnOnClose         Set to '0' or '1'. When set to '1'
  300.                                    causes the Orion Query Editor to
  301.                                    prompt the user for a file name
  302.                                    before closing a pad which contains
  303.                                    text not yet saved to disk.
  304.  
  305.                SQL For Windows also relies upon the international date
  306.                and time settings.  The Windows defaults are fine and you
  307.                can leave them alone.  If you've changed them, don't
  308.                worry, time stamps are saved in binary and not converted
  309.                to international format until used for output.  If you're
  310.                interested, we recommend the following settings:
  311.  
  312.                     [intl]
  313.                     iDate=0
  314.                     iTime=0
  315.                     s1159=AM
  316.                     s2359=PM
  317.  
  318.                International date and time settings are most easily
  319.                changed via Microsoft's Windows Control Panel.  Select
  320.                the "International" icon then click on either "date" or
  321.                "time".
  322.  
  323.           6)   Use Microsoft's Program Manager to create a new program
  324.                group:
  325.  
  326.                a) select 'File', 'New'
  327.  
  328.                b) select 'Program Group', 'OK'
  329.  
  330.                c) Enter description: 'Orion', group file: 'ORION'
  331.  
  332.                d) select 'OK'
  333.  
  334.           7)   Use Microsoft's Program Manager to create two new program
  335.                items:
  336.  
  337.                a) select 'File', 'New'
  338.  
  339.                b) select Program Item, 'OK'
  340.  
  341.                c) Enter description: 'Dba', command line: 'DBA.EXE'
  342.           General Information                                Page 7 of 8
  343.  
  344.  
  345.                d) select 'OK'
  346.  
  347.                e) select 'File', 'New'
  348.  
  349.                f) select Program Item, 'OK'
  350.  
  351.                g) Enter description: 'Qe', command line: 'QE.EXE'
  352.  
  353.                h) select 'OK'
  354.  
  355.           8)   Start the Orion Database Administrator by clicking on the
  356.                'Dba' Icon in the Microsoft Program Manager.  When the
  357.                Orion Database Administrator complains that it can't find
  358.                a database, click on "OK".  Now select 'Toolbox' in the
  359.                main menu.  Select the 'Install' entry, this will install
  360.                the database in the directory identified by the
  361.                'DatabasePath' setting described above.
  362.  
  363.           9)   At this point the database is fully installed.  To run
  364.                some sample queries, see the section "Example Queries"
  365.                below.
  366.  
  367.           10)  If you're not going to use the Orion SQL Applications
  368.                Programming Interface (API), you may exit ('Exit' is in
  369.                the 'File' menu) the Orion Database Administrator.
  370.  
  371.           11)  If you intend to use the Orion SQL API for 'C' program
  372.                development:  Move SQL.LIB into some directory where it
  373.                is accessible by your linker (usually c:\windev\lib).
  374.                Move SQL.H to a directory where it is accessible to the
  375.                compiler (usually c:\c\include).  You will probably want
  376.                to read SQL.DOC.  A sample application program is
  377.                included as EXAMPLEC.*.  You ought to compile, link and
  378.                run it (the batch file EXAMPLEC.BAT is included to
  379.                accomplish this) to familiarize yourself with the Orion
  380.                SQL API.
  381.  
  382.           12)  If you intend to use the Orion SQL API for 'Visual Basic'
  383.                program development:  A sample application program is
  384.                included.  Move EXAMBLEB.* to a directory where you keep
  385.                your 'Visual Basic' programs (usually c:\vb).  You ought
  386.                to compile and run EXAMPLEB to familiarize yourself with
  387.                the Orion SQL API.  You will probably want to read
  388.                SQL.DOC.
  389.  
  390.  
  391.  
  392.                                  Example Queries
  393.  
  394.  
  395.           You will probably want to run our examples to familiarize
  396.           yourself with the operation of SQL For Windows.
  397.           General Information                                Page 8 of 8
  398.  
  399.  
  400.           1)   Start the Orion Database Administrator by clicking on the
  401.                'Dba' Icon in the Microsoft Program Manager.  The
  402.                database ought to start automatically.  If you didn't set
  403.                AutoStart=1 in the WIN.INI file, when the Orion Database
  404.                Administrator's window appears select 'Control' from its
  405.                menu.  Select the 'Start' entry, this will start the
  406.                database.
  407.  
  408.           2)   Start the Orion Query Editor by clicking on the 'Qe' icon
  409.                in the Microsoft Program Manager.  When the Orion Query
  410.                Editor's window appears select 'File' from its menu.  Now
  411.                select the 'Open' entry and open the file CREATE.SQL.
  412.                This is one of the files contained in EXAMPLE.ZIP.  When
  413.                its text appears in a pad select the menu commands
  414.                'Database', 'Execute' (or hit control/x).  This query
  415.                creates the tables of the example database.
  416.  
  417.           3)   Now go to the Orion Database Administrator and select the
  418.                menu commands 'File', 'Import'.  Select the file
  419.                EXAMPLE.DAT.  This is one of the files contained in
  420.                EXAMPLE.ZIP.  The 'Import' loads the data in EXAMPLE.DAT
  421.                into the tables you created with CREATE.SQL.
  422.  
  423.           4)   You can now execute any of the sample queries contained
  424.                in EXAMPLE.ZIP.  Go to the Orion Query Editor, open a
  425.                file (for example QUERY01.SQL) and execute it.  Files
  426.                which contain select statements will cause the Orion
  427.                Query Editor to open a new pad and place the results as
  428.                text into the new pad.  You may then edit the data and/or
  429.                save it to a file using the 'File', 'Save As' commands.
  430.  
  431.           5)   To remove the sample data from the database just execute
  432.                the SQL 'drop table' statements in the DROP.SQL file.
  433.  
  434.           6)   You are now ready to write your own SQL statements and
  435.                create your own database.
  436.  
  437.           Stellar Industries:      (714) 861-7885
  438.                                    3335 S. Falcon Ridge Road
  439.                                    Diamond Bar, CA  91765